home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / wildcat / cc_v591.zip / CALCAT.DOC < prev    next >
Text File  |  1996-01-09  |  23KB  |  441 lines
  1.  
  2.  
  3. CalCat! v5.91  Compiled January 8, 1996
  4. (c) Copyright 1991-1996 by Bart Flentje
  5. By Bart Flentje and Chad Flentje
  6. ======================================================================
  7.  
  8. Legal                                                            
  9.        
  10. CalCat! is provided "AS IS" without any warranty of any kind, either
  11. expressed or implied as to the merchantability or fitness of purpose.
  12. The risk as to the quality and performance of the software is the end
  13. user's.  The Author shall have no liability or responsibility to the
  14. user with respect to the liability, loss or damage caused or alleged
  15. to be caused by this software, including, but not limited to, any
  16. interruption of service, loss of business or anticipatory profits or
  17. consequential damages resulting from the use of, or the inability to
  18. use the software.
  19.  
  20. The information in this document is subject to change without notice
  21. and does not represent a commitment on the part of the Author.  Any
  22. registration fee sent to the author is non-refundable and by
  23. registering your SHAREWARE the user acknowleges such.  However, the
  24. author will do what he/she can to make operation or setup of such
  25. program simple and straight forward.
  26.      
  27. ======================================================================
  28.  
  29. Copying and Distribution:
  30.  
  31. CalCat! is  (c) copyright 1992-1996 by Bart Flentje.  It is also
  32. registered with United States Library of Congress as such. That means
  33. registered versions of CalCat! cannot be copied and/or distributed
  34. without the express written consent of the author.  However, CalCat!
  35. can be copied and distributed so long it is an unregistered version
  36. and is accompanied with the appropriate key designating it as
  37. SHAREWARE.  No  changes or modifications may be made without the
  38. authors approval.  It is also a violation to use CalCat!  past an
  39. authorized date unless a new key has been issued and released by the
  40. author.  IT IS a violation of Federal COPYRIGHT Laws to distribute
  41. registered versions of this software whether it be the software itself
  42. or a registration key.
  43.      
  44. =====================================================================
  45.  
  46. Registration:
  47.  
  48. CalCat! is NOT  public domain, it is SHAREWARE.  That means that you
  49. have to  pay registration fees ($12.00)  if you use CalCat! in any
  50. way or form.  The registration cost is minimal and considered to be
  51. below market standards.  Registration fee will allow the author to
  52. write new  and improved versions of CalCat!.  Registering your
  53. software will enable the following features: The Unregistered tagline
  54. will go away from the top of your screen, you will be allowed 80 swap
  55. file locations instead of just one, you will be allowed 25 swap screens
  56. rather than just one, discounted pricing on future versions of CalCat!
  57.  
  58. =====================================================================
  59.  
  60. Description of files:
  61.  
  62. - CALCAT.DOC    This documentation
  63. - CONFIG.EXE    Database management utility
  64. - CALCAT.EXE    The CalCat! program file to be run as event
  65. - CALCAT.BAT    Sample batch file to start CalCat! event
  66. - CALCAT.INI    .INI configuration support file
  67. - CALCAT.DAT    Holiday data file.  Back this up!
  68. - CALCAT.SWP    Swap screen data support file
  69. - RELEASE.DOC   Version release information and history
  70. - HOLISCRN.ZIP  Archive file containing 242 holiday screens
  71. - REGISTER.DOC  This registers your SHAREWARE!!
  72.  
  73. =====================================================================
  74.  
  75. What is CalCat! ?
  76.  
  77. CalCat! is a utility that was originally written for my BBS to
  78. automatically swap in a new HELLOX. screen on holidays, thus saving me
  79. a lot of work.  It started out with just half dozen or so major
  80. holidays and has progressed since.  Right now, CalCat! is supplied
  81. with a data file that will check for over two hundred holidays.  This
  82. data file has the necessary data to place your holiday screens where
  83. you want them regardless of the year.  No more monkeying with date
  84. shifting.  (e.g. President's Day is the 3rd Monday in February)
  85. CalCat! does it for you.  Beyond that, CalCat! also allows you to
  86. randomly or sequentially swap in other screens on non-holiday days!
  87. CalCat! is easy to setup and should be run as an event (preferred) or
  88. as postcall.bat by Wildcat!.
  89.  
  90. ======================================================================
  91.  
  92. How do I install CalCat! ?
  93.  
  94. There are three basic steps to setup CalCat!
  95.  
  96. I.    Set up your new event directory.
  97. II.   Customize your information and database files.
  98. III.  Set up your event in Wildcat!
  99.  
  100. ---------------------------------------------------------------------
  101.  
  102. I.
  103.     A. Create a new directory for CalCat!  For better organization,
  104.        I create a directory for each event that I run.  My CalCat!
  105.        event path looks like this:  M:\WILDCAT\CALCAT
  106.         
  107.     B. Copy ALL CalCat! files into your new event directory.  That will
  108.        include CALCAT.EXE, CALCAT.INI, CALCAT.DAT, CONFIG.EXE, CALCAT.SWP,
  109.        HOLISCRN.ZIP....ect etc etc.  (The whole works)
  110.     
  111.     C. Inside my event directory, I have created a sub directory for all 
  112.        of the holiday screens.  This is for purely organizational purposes. 
  113.        That path looks like such;  M:\WILDCAT\CALCAT\SCREENS.  Here is where 
  114.        you have the new option.  You can either copy HOLISCRN.ZIP into
  115.        this sub directory or you can unzip the contents of HOLISCRN.ZIP
  116.        into the sub directory.  Which ever way you decide to go, you will
  117.        determine the setting when setting up the .INI file.
  118.  
  119. ---------------------------------------------------------------------
  120.  
  121. II.  Make sure you are now in your new event directory.  We'll modify your 
  122.      database files to suit your individual needs.  Run CONFIG.EXE which 
  123.      is the database management utility.  
  124.  
  125.      First we need to modify personal details.  So choose option one (1)
  126.      from the menu which allows you to set up CalCat! for you and your
  127.      computer.  Edit CALCAT.INI menu option looks something like this:
  128.  
  129.  
  130.    SYSOP Name: Bart Flentje              <--- Sysops first and last name
  131.    BBS Name: Eagan Wildcat! BBS          <--- Name of your BBS
  132.    User Key: 0000000                     <--- Your user key here
  133.    SourcePath: C:\WC30\EVENT1\SCREENS\   <--- Path of Source Holiday Screens
  134.    Archive File: HOLISCRN.ZIP            <--- Name of ZIP file
  135.    ASCII Screen: BBS                     <--- ASCII file identifier
  136.    ANSI Screen: SCR                      <--- ANSI file identifier
  137.    Graphic Screen: RIP                   <--- Graphic file identifier
  138.  
  139.    The following data will help explain the information needed in the  
  140.    .INI file.  Use the arrow keys or mouse to choose which field you need  
  141.    to modify.  The following list helps explain the contents of this menu.
  142.    
  143.    1. Sysop Name:  This is the first and last name of sysop.
  144.        
  145.    2. BBS Name:    The name of your BBS.
  146.        
  147.    3. User Key:    This is the key registered in your name, or an official     
  148.                    SHAREWARE key issued by the author.
  149.        
  150.    4. SourcePath:  This is the path where CalCat! will find your holiday
  151.                    screens.  If a holiday file does not exist at this
  152.                    path, CalCat! will abort it's operation.  CalCat! is
  153.                    NOT sensitive to backslash at the end of the path.
  154.  
  155.  
  156.    5. Archive:     This is where you specify whether you would like to
  157.                    store the holiday screens in ZIP archive form or not.
  158.                    This new line must exist.  If you WOULD like to store
  159.                    holiday screens in archive form, put the name of the
  160.                    archive file here.  The screens included in SHAREWARE
  161.                    version have been preZipped, so I would recommend that
  162.                    you just leave the screens as is and put HOLISCRN.ZIP
  163.                    in this field.  If you choose to store the holiday 
  164.                    screens in the extracted form, this line MUST exist but
  165.                    leave the field blank.
  166.        
  167.    6. ASCII Screen:  Most BBS packages produced today allow you to use 
  168.                      two sets of screens.  These two screens types are 
  169.                      usually ANSI and ASCII, one set allowing for advanced 
  170.                      colors and animation, and the other allows color or 
  171.                      black and white, respectively.  CalCat! is now setup 
  172.                      to go beyond Wildcat!'s .BBS and .SCR making CalCat! 
  173.                      compatible with several other packages on the market.  
  174.                      In this field, simply put the ASCII screen identifier 
  175.                      used by your BBS package here.  Again, this line is 
  176.                      more important to your BBS than for the operation of 
  177.                      CalCat!.  An identifier that is wrong will cause your 
  178.                      BBS to not find your holiday file.  Putting a file
  179.                      extension field will ENABLE the ASCII format output.
  180.  
  181.    7. ANSI Screen:   As in above, simply put the ANSI identifier used by
  182.                      your BBS package here.  It is not case sensitive.
  183.                      Putting a file extension in this field will ENABLE
  184.                      the ANSI format output.
  185.  
  186.    8. Graphic Screen: As in above, simply put the graphic screen 
  187.                       identifier used by your BBS package here. It is not 
  188.                       case sensitive.  Adding file extension here will
  189.                       ENABLE the graphic output.  This is only available
  190.                       to registered users.
  191.  
  192.                       CalCat! now will copy any combination of ANSI,
  193.                       ASCII, or RIP format, meaning, if an extension
  194.                       is in any one of these fields, it will look for
  195.                       the appropriate screen to copy.  What this means
  196.                       is that you may now swap the BBS, SCR, & RIP at
  197.                       the same time or any combination of the three.
  198.                       (As long as appropriate formats exist in the
  199.                        screens archive!)
  200.  
  201.    That should do it for personal data, that didn't seem too bad, did it?
  202.  
  203. ----------------------------------------------------------------------
  204.  
  205. III. Next step is to modify your swap data to meet the needs of your
  206.      BBS. To do this, you need to step back to the main menu of CONFIG
  207.      and select option 2, modify SWAP.DAT.
  208.  
  209.      CalCat! now has the ability to swap screens into 10 different
  210.      locations.  As you can see from the list, these will be referred
  211.      to as target files, and they can be any display file within
  212.      Wildcat! so long as the actual display file can be found in the
  213.      "Target Path" as defined in the edit CALCAT.INI menu.  (such as
  214.      HELLO1, PRELOG, GOODBYE etc.).
  215.  
  216.      Choose one of these target files using the arrow keys or mouse and we 
  217.      will modify one to show you how it's done.
  218.  
  219.      I will choose to modify TargetFile #1, submenu for TargetFile #1 now
  220.      comes up looking like such:
  221.          
  222.      Target File Name: HELLO1      <--- Name of target file.
  223.      Target File Path: H:\DISP\    <--- Where you want file copied to
  224.      On/Off Switch: On             <--- Used to turn target file on/off
  225.      Flagged for Holiday: On       <--- toggles holiday swaps on/off
  226.      Sequence Type: Random         <--- toggles swap type on non-holiday
  227.      Last Copied: 2                <--- Last screen swapped.  Internal
  228.      Top Line:                     <--- Field to add your BBS clear code
  229.      Bottom Line:                  <--- Field to add your BBS pause code
  230.      Bottom Line Number:           <--- Customize bottom line number
  231.      Swap Screens:  <list button>  <--- Hit enter to list swap screens
  232.  
  233.      The following is detailed information of each option.
  234.  
  235.      1. Target File Name:  This is the name of the display file you want
  236.                            to assign to this particular target file.  This
  237.                            display file must be able to be found by WC         
  238.                            in the target path as assigned by you in the
  239.                            edit CALCAT.INI menu.  Notice that there is no
  240.                            dot (.) or a screen type identifier... this IS
  241.                            the correct syntax, for CalCat! will determine
  242.                            the screen identifier by the holiday database.
  243.          
  244.      2. On/Off Switch:  This toggles the target file on or off.  You must
  245.                         have at least one target file turned on for the
  246.                         CalCat! program to work.  Any number of these
  247.                         target files can be turned on or off and will
  248.                         operate so long as target file name is assigned
  249.                         and there exists screens in the swap list.
  250.                         See #6
  251.  
  252.      3. Flagged for Holiday:  This option allows you to control the 
  253.                               holiday swaps of each individual target
  254.                               file.  Any number of target files can be
  255.                               toggled as flagged for holiday.
  256.  
  257.      4. Sequence Type:  This can be toggled as random or sequential.
  258.                         this function determines the swap technique
  259.                         used when there are no holidays or when the
  260.                         holiday flag has been turned off.
  261.  
  262.      5. Last Done:  This was the last screen copied from the swap list.
  263.                     This is changed internally and canbe modified.
  264.  
  265.      6. Top Line:  Most BBS packages allow SysOps to add a proprietary
  266.                    clear screen variable.  You may add this code to the
  267.                    top line or leave it blank.  Optional.  For example,
  268.                    Wildcat uses @CLS@ to clear screens.
  269.  
  270.      7. Bottom Line:  This is the same as top line but allows you to
  271.                       add a custom code at the bottom such as a pause
  272.                       prompt.  For example, Wildcat uses @PAUSE@.  This
  273.                       field is optional.
  274.  
  275.      8. Bottom Line Number:  Allows you to control where the bottom line
  276.                              code is placed if used.  This is needed
  277.                              because all BBS packages have default lines
  278.                              per screen allowed.  For example, Wildcat
  279.                              uses either 23 or 24.  Keep in mind that
  280.                              any information AFTER this line number will
  281.                              be truncated from your screens.
  282.  
  283.      9. Swap List:  Choose this option to add display screens to the swap
  284.                     list.  These are the screens to be swapped when:
  285.                      - Target file toggled for holiday and there is
  286.                        no damn holiday.
  287.                      - Target file is not toggled for holiday.
  288.                      If you add screens to this swap list, YOU MUST
  289.                      REMEMBER to ADD your new screens to HOLISCRN.ZIP or
  290.                      they will NOT be swapped.  You have the ability to
  291.                      add up to 20 display screens for EACH target file.
  292.                      This means if you use CalCat! to it's full potential,
  293.                      you can swap up to 200 display screens.  Duh!
  294.  
  295.     This should do it for the swap data.  Remember, if you have troubles
  296.     to use your common sense.  The information to be edited is very
  297.     straight forward.
  298.  
  299. ----------------------------------------------------------------------
  300.  
  301. IV.  With CalCat's new database system, it is now easier for you to turn
  302.      holidays on and off, or add holidays to the database.  I won't go into
  303.      too much detail on how to modify the holiday database, because it is
  304.      very straight forward so long as you use the key options presented and
  305.      that you pay attention to the screen.
  306.       
  307.      To edit or add holidays to the holiday database, you first need to be
  308.      back at the main menu of CONFIG50.EXE and choose option 3.  Edit the
  309.      CALCAT.DAT database.
  310.  
  311.      The menu will look like this:
  312.  
  313.      Add New Holiday:   <--- Lets you add your own holidays to database
  314.      Edit Holiday:      <--- Allows you to edit holiday already in database
  315.      Delete Holiday:    <--- Allows you to delete a holiday from the database
  316.      List Holidays:     <--- Lists holidays for you.  Sorted or unsorted
  317.      Print Holidays:    <--- Prints list of holidays sorted or unsorted
  318.  
  319.  
  320.      Details of the above options are as follows:
  321.  
  322.      1. Add New Holiday:  This option lets you add your own date sensitive
  323.                           holiday to the database.  Remember, if you add a 
  324.                           holiday, make sure your new holiday display screen
  325.                           is put into HOLISCRN.ZIP or it will not be copied.
  326.  
  327.      2. Edit Holiday:  This option allows you to edit any holiday that YOU 
  328.                        have added to the database.  Holidays provided by the
  329.                        author CANNOT be modified besides turning them on or
  330.                        off unless you are registered.
  331.  
  332.      3. Delete Holiday:  This option allows you to delete any holiday that 
  333.                          YOU have added to the database.  Holidays supplied
  334.                          by the AUTHOR CANNOT be removed from the database
  335.                          unless you are registered.
  336.  
  337.      4. List Holidays:  This allows you to easily view the list of holidays
  338.                         either sorted or unsorted.  Two different sorting
  339.                         options are by alphabetical or by date.
  340.  
  341.      5.  Print Holidays:  This allows you to easily print a list of holidays
  342.                           either sorted or unsorted.  Two different sorting
  343.                           options are by alphabetical or by date.
  344.  
  345.      Add New Holiday & Edit Holiday sub menus.
  346.  
  347.      - Holiday Name:  Name your holiday.  Easter, Birthday, etc.
  348.                       (max of 30 characters)
  349.            
  350.      - Holiday Code:  Name of your display screen that YOU WILL add
  351.                       to HOLISCRN.ZIP in order for it to work properly.
  352.                       (max of 12 characters in proper DOS syntax, also
  353.                       must have prefered identifier.  eg SCREEN1.BBS
  354.                       minus the extension!)
  355.            
  356.      - Author Lock:   This function is for me to lock and unlock author
  357.                       holidays for edit.  No sense in tampering with
  358.                       this option, it does not exist outside of my
  359.                       home.
  360.            
  361.      - On/Off Switch:  Allows you to toggle holidays on or off.  Easy
  362.                        enough, if you don't want it to show up, turn it
  363.                        off.
  364.            
  365.      - Holiday Type:  There are three holiday types: 1) Constant, which
  366.                       is a holiday such as Christmas which has the same
  367.                       date every year.  2) Variable, which is a holiday
  368.                       such as Memorial Day which is different every year.
  369.                       3) Internal, which is a holiday such as Easter
  370.                       which needs to be determined by special algorithm
  371.                       due to its uniqueness.  All internals are done by
  372.                       the author.
  373.            
  374.      - Month:  This obviously will be the month of holiday in question.
  375.  
  376.      - Day:  This can have two meanings:  1) Constant holiday, this will
  377.              be the day of month holiday falls.  2) Variable holiday,
  378.              this will be the "day of week" the holiday falls.  eg Monday
  379.  
  380.      - Week:  This option is for Variable holidays only.  It is the
  381.               week the holiday falls.  For example, Columbus Day is the
  382.               2nd Monday in October, that means this would be set to 2
  383.               and the day would be set to Monday. (above)
  384.  
  385.      - Shift:  This option is used for certain holidays that depend on
  386.                another.  Such as, Ascension Day is 50 days after the
  387.                Christmas, which could easily be calculated on your own.
  388.                With this, you could set the holiday to Christmas' date
  389.                with a shift of 50, and it will count the days for you
  390.                while also accounting for leap year.
  391.  
  392. ----------------------------------------------------------------------
  393.  
  394.      **  Well that should do it.  You know the basics for holiday house
  395.          keeping.
  396.  
  397. ----------------------------------------------------------------------
  398.  
  399. V.    Set up event in SYSOP menu area of Wildcat! BBS using the
  400.       CALCAT.BAT sample file.  Run once per day preferably at say
  401.       12:01 A.M.  Once installed properly, event only takes
  402.       approximately 3 seconds to run so will not interfere with incoming
  403.       calls.
  404.  
  405. ----------------------------------------------------------------------
  406.  
  407. That should do it.  CalCat! is now ready to be run.  You can run it outside
  408. of Wildcat! obviously if you'd like to see it run.  Not much to see though
  409. until you log onto your BBS system.
  410.  
  411. PLEASE PLEASE PLEASE REMEMBER................
  412.  
  413. I have supplied ANSI, attribute, and RIP screens for the 242+ holidays 
  414. that are already installed in the CALCAT.DAT file.  Please cut me some 
  415. slack on these screens.  Some of them are from other authors and some of 
  416. them are made by me.  Every attempt has been made to retain the original 
  417. work by other authors and by also leaving their mark, (name) on their work.  
  418. I respect the hard work and creativity by these people, and I hope you 
  419. also appreciate them.  ANSI authors make your life easier!!
  420.  
  421. ======================================================================
  422.  
  423. Enjoy CalCat! and if you have any problems or suggestions for improvements,
  424. please feel free to contact me, Bart Flentje, on the MSI HQS BBS or you can
  425. write to me at:
  426.  
  427. Bart Flentje
  428. 1718 Hickory Hill
  429. Eagan, MN 55122-2410
  430.                 
  431. BBS   (612) 686-8106
  432.       (612) 452-8413
  433.                  
  434. FIDO  1:282/4074
  435. Internet  sysop@bitdebris.com
  436.                  
  437. Thanks for the support!
  438.  
  439.  
  440.  
  441.